Manage Order API
Methods and endpoints
The Manage Order API allows you to:
- Get, Post, Patch or Delete operations on an order
- Get a list of an order's notifications
- Get and Post operations on order attachments.
The Manage Order API includes the following methods and endpoints.
| Endpoint description | Method and endpoint | Function |
|---|---|---|
| API asset version | GET /version | Retrieves the full version of the API asset (major, minor and patch version numbers) |
| Create order | POST /orders/{orderId} | Allows RSPs to submit an order request that has previously been confirmed as feasible as part of an Order Feasibility request by the same RSP |
| Amend order | PATCH /orders/{orderId} | You receive a request from us, or your customer, to modify an order or you want to interact with us on regarding the order |
| Cancel order | DELETE /orders/{orderId} | Allows RSPs to request to cancel an order by the same RSP |
| Get order details | GET /orders/{orderId} | Returns the details of an order based on the Order ID, if the order is owned by the requesting RSP |
| Get order attachments | GET /orders/{orderId}/attachments/{attachmentId} | Returns the details of an attachment linked to an order |
| Get order notifications | GET / orders/{orderId}/notifications | Returns the details of all notifications that have been sent for an order |
Attributes for POST /orders/{orderId} endpoint
Order Types: Connect Primary, Connect Secondary, Transfer Primary, Transfer Secondary, Change Offer, Modify Attribute for Product Family: Bitstream
| Attribute | Description |
|---|---|
| connectRFSDateTime | Mandatory attribute for orders without a site visit or a CSE, used as part of the POST /orders/{orderId} endpoint to confirm the date and time an order will be ready for service (RFS).Notes: - To find appointments for this attribute, use GET /rfsAppointmentAvailability in the Appointment API.- Appointment details for orders with a site visit or a CSE are managed via the Appointment API. Learn more about the Manage Appointment API Learn more about Chorus Portal CSE Offers |
| productOfferDetails | Mandatory array used as part of the POST /orders/{orderId} endpoint to show the product offer details associated with the request.The array must contain: 1. Product offer ID (from the product catalogue) 2. Product offer characteristics (name/value pairs) Note: Values for the product offer characteristic attributes are available in the product catalogue. |
| cseProductOfferDetails | Mandatory array for orders with a site visit or a CSE, used as part of the POST /orders/{orderId} endpoint to show the details of the CSE product offer details associated with the request.The array must contain: 1. CSE product offer ID (from the product catalogue) 2. CSE product offer characteristics (name/value pairs) Note: Values for the CSE product offer characteristic attributes are available in the product catalogue. |
| orderDetails.contactDetails | Mandatory attribute used as part of the POST /orders/{orderId} endpoint to add contacts and order specific information to the order.You can optionally supply additional contact types relevant to the order. If adding one of the following contact types, you must supply a contactName and preferredPhone for the contact: - Order Contact - Site Contact - IT Contact - Additional Contact - Legal Owner - Body Corporate - Property Manager. You can optionally supply the following attributes for any contact you have added to the order: - alternatePhone - email. Business Rule: Chorus-ManageOrder-2 |
| orderDetails.locationDetails | Mandatory attribute used as part of the POST /orders/{orderId} endpoint to add location details to the order. For Business and Education market segments, you must supply a value for the locationOfEquipment attribute. Note: You can also supply any site access information relevant to the order. Business Rule: Chorus-ManageOrder-4 |
| orderDetails.customerDetails | Mandatory attributes used as part of the POST /orders/{orderId} endpoint to add customer details on the order.You must always supply a value for the following attributes: - endCustomerName - providerReference - notificationPreference Notes: - If Project name is used on order submission, it can’t be amended after the order is created. - When notificationPreference is set to Notify, you must supply an email address for the notificationEmail attribute. Business Rule: Chorus-ManageOrder-5 |
| orderDetails.billingDetails | Mandatory attribute used as part of the POST /orders/{orderId} endpoint for billing details on the order. You must provide a billing account number. |
Order Types: Connect Additional ONT for Product Family: Bitstream
| Attribute | Description |
|---|---|
| productOfferDetails | Mandatory array used as part of the POST /orders/{orderId} endpoint to show the product offer details associated with the request.The array must contain: 1. Product offer ID (from the product catalogue) 2. Product offer characteristics (name/value pairs) Note: Values for the product offer characteristic attributes are available in the product catalogue. |
| cseProductOfferDetails | Mandatory array for orders with a site visit or a CSE, used as part of the POST /orders/{orderId} endpoint to show the CSE product offer details associated with the request.The array must contain: 1. CSE product offer ID (from the product catalogue) 2. CSE product offer characteristics (name/value pairs) Note: Values for the CSE product offer characteristic attributes are available in the product catalogue. Learn more about Chorus Portal CSE Offers |
| orderDetails.contactDetails | Mandatory attribute used as part of the POST /orders/{orderId} endpoint to add contacts and order specific information to the order.You can optionally supply additional contact types relevant to the order. If adding one of the following contact types, you must supply a contactName and preferredPhone for the contact: - Order Contact - Site Contact - IT Contact - Additional Contact - Legal Owner - Body Corporate - Property Manager. You can optionally supply the following attributes for any contact you have added to the order: - alternatePhone - email. Business Rule: Chorus-ManageOrder-2 |
| orderDetails.locationDetails | Used as part of the POST /orders/{orderId} endpoint to add location details to the order. For Business and Education market segments, you must supply a value for the locationOfEquipment attribute. Note: You can also supply any site access information relevant to the order. Business Rule: Chorus-ManageOrder-4 |
| orderDetails.customerDetails | Mandatory attributes used as part of the POST /orders/{orderId} endpoint to add customer details on the order.You must always supply a value for the attributes: - endCustomerName - providerReference - notificationPreference Notes: - If Project name is used on order submission, it can’t be amended after the order is created. - When notificationPreference is set to Notify, you must supply an email address for the notificationEmail attribute. Business Rule: Chorus-ManageOrder-5 |
| orderDetails.billingDetails | Mandatory attribute used as part of the POST /orders/{orderId} endpoint for billing details on the order. You must provide a billing account number. |
Order Types: Move Primary, Move Additional ONT for Product Family: Bitstream
| Attribute | Description |
|---|---|
| connectRFSDateTime | Mandatory attribute for orders without a site visit or a CSE, used as part of the POST /orders/{orderId} endpoint to confirm the date and time an order will be ready for service (RFS).Notes: - Values for this attribute are available by using GET /rfsAppointmentAvailability in the Manage Appointment API.- Orders with a site visit have their details managed via the Manage Appointment API. Learn more about the Manage Appointment API Learn more about Chorus Portal CSE Offers |
| disconnectRFSDateTime | Mandatory attribute used as part of the POST /orders/{orderId} endpoint to confirm the date and time an order will be disconnected and billing ceased. Note: Values for this attribute are available by using GET /rfsAppointmentAvailability in the Manage Appointment API.Learn more about the Manage Appointment API |
| productOfferDetails | Mandatory array used as part of the POST /orders/{orderId} endpoint to show the product offer details associated with the request.The array must contain: 1. Product offer ID (from the product catalogue) 2. Product offer characteristics (name/value pairs) Note: Values for the product offer characteristic attributes are available in the product catalogue. |
| cseProductOfferDetails | Mandatory array for orders with a site visit or a CSE, used as part of the POST /orders/{orderId} endpoint to show the CSE product offer details associated with the request.The array must contain: 1. CSE product offer ID (from the product catalogue) 2. CSE product offer characteristics (name/value pairs) Note: CSE product offer characteristic attributes are available in the product catalogue. |
| orderDetails | Mandatory attribute used as part of the POST /orders/{orderId} endpoint to add contacts and order specific information to the order.You can optionally supply additional contact types relevant to the order. If adding one of the following contact types, you must supply a contactName and preferredPhone for the contact: - Order Contact - Site Contact - IT Contact - Additional Contact - Legal Owner - Body Corporate - Property Manager. For any contact you have added to the order, you can optionally supply the following attributes: - alternatePhone - email. Business Rule: Chorus-ManageOrder-2 |
| locationDetails | Used as part of the POST /orders/{orderId} endpoint to add location details to the order.For Business and Education market segments, you must supply a value for the locationOfEquipment attribute. Note: You can also supply any site access information relevant to the order. Business Rule: Chorus-ManageOrder-4 |
| customerDetails | Used as part of the POST /orders/{orderId} endpoint to add customer details on the order.You must always supply a value for the attributes: - endCustomerName - providerReference - notificationPreference Notes: - If Project name is used on order submission, it can’t be amended after the order is created. - When notificationPreference is set to Notify, you must supply an email address for the notificationEmail attribute. Business Rule: Chorus-ManageOrder-5 |
| billingDetails | Mandatory attribute used as part of the POST /orders/{orderId} endpoint for billing details on the order. You must provide a billing account number. |
Order Types: Disconnect Primary, Disconnect Secondary for Product Family: Bitstream
| Attribute | Description |
|---|---|
| disconnectRFSDateTime | Mandatory attribute used as part of the POST /orders/{orderId} endpoint to confirm the date and time an order will be disconnected and billing ceased. Note: Values for this attribute are available by using GET /rfsAppointmentAvailability in the Manage Appointment API.Learn more about the Manage Appointment API |
| orderDetails.contactDetails | Optional attribute used as part of the POST /orders/{orderId} endpoint to add contact details to the order. |
| orderDetails.locationDetails | Optional attribute used as part of the POST /orders/{orderId} endpoint to add location details to the order.Business Rule: Chorus-ManageOrder-4 |
| orderDetails.customerDetails | Mandatory attribute used as part of the POST /orders/{orderId} endpoint to add customer details on the order.You must always supply a value for the attributes: - endCustomerName - providerReference - notificationPreference Notes: - When notificationPreference is set to Notify, you must supply an email address for the notificationEmail attribute. Business Rule: Chorus-ManageOrder-5 |
| billingDetails | Mandatory attribute used as part of the POST /orders/{orderId} endpoint for the billing details on the order. You must supply a value for the billingAccount attribute. |
Attributes for PATCH /orders/{orderId} endpoint
amendOrderType: Answer
These attributes are used to answer a question from Chorus or confirm that you have completed all requested actions.
| Attribute | Description |
|---|---|
| amendOrderType | Mandatory attribute used as part of the PATCH /orders/{orderId} endpoint to select an amendment type.This attribute must have the value: Answer. |
| questionAnswer | Mandatory array used as part of the PATCH /orders/{orderId} endpoint to answer a question.Values are required for the following attributes: - questionId must have the questionId value associated with the order - questionValue is provided to confirm and request further action on the order - answerValue must have one value provided from the values associated with the order questionValue The following questionValue items may be provided: - A quote has been added to this order - Please confirm if you APPROVE or REJECT the supplied quote - A request has been made to cancel this order - Please confirm if you ACCEPT or REJECT this request - Please check with your end customer and either ACCEPT or REJECT this request - Please confirm if you ACCEPT or REJECT this request - Please confirm if you ACKNOWLEDGE, REJECT or wish to EXTEND by 7,14,21,28 days this request answerValue The following answerValue items may be supplied: - APPROVE - REJECT - ACCEPT - ACKNOWLEDGE - EXTEND |
| reason | Mandatory array used as part of the PATCH /orders/{orderId} endpoint to provide a reason if the answerValue is REJECT. If you use REJECT for the following questionValue items, you must provide a reason code and note: - A request has been made to cancel this order - Please confirm if you ACCEPT or REJECT this request - Please confirm if you ACCEPT or REJECT this request - Please confirm if you ACKNOWLEDGE, REJECT or wish to EXTEND by 7,14,21,28 days this request The following values are required for the code and note attributes: - code must have one value: - ITC_REJECT_01 – Chorus Action Required - ITC_REJECT_02 - Further Details Needed - ITC_REJECT_03 - More Time Needed - ITC_REJECT_04 - Ready to Proceed - note must have a value if you use reject reason 01 or 02, and a comment must be provided detailing the reject reason. |
amendOrderType: Characteristic
Note: These attributes are used to request a change to a product characteristic.
| Attribute | Description |
|---|---|
| amendOrderType | Mandatory attribute used as part of the PATCH /orders/{orderId} endpoint to select an amendment type.This attribute must have the value: Characteristic. |
| productOfferDetails OR cseProductOfferDetails | Mandatory attribute(s) used as part of the PATCH /orders/{orderId} endpoint to update characteristics associated with the product offer or CSE product offer.These attributes must have an associated product characteristic value from the order you want to amend. Notes: - The attribute productOfferId cannot be changed once the order is submitted, to change the productOfferId submit a new feasibility request. - Product offer/CSE product offers characteristic attributes are available in the product catalogue. |
amendOrderType: Escalate
Note: These attributes are used to request a higher priority for processing of an order.
| Attribute | Description |
|---|---|
| amendOrderType | Mandatory attribute used as part of the PATCH /orders/{orderId} endpoint to select an amendment type.This attribute must have the value: Escalate. |
| escalationDetails | Mandatory array used as part of the PATCH /orders/{orderId} endpoint to request an escalation. The escalationReason attribute must have one of the following values supplied: - Medical Emergency - Civil Defence or Essential Services - Missed Commitment - Provisioning Error. The mandatory attribute escalationComment must have a value that provides a summary or reason for your escalation request. The escalationComment must be at least one character and a maximum of 4000 characters in length. Learn more about escalating an order with Chorus |
amendOrderType: Interaction
Note: Use this attribute when you need to send us a message or information about your order.
| Attribute | Description |
|---|---|
| amendOrderType | Mandatory attribute used as part of the PATCH /orders/{orderId} endpoint to select an amendment type.This attribute must have the value: Interaction. |
| Interaction | Mandatory attribute used as part of the PATCH /orders/{orderId} endpoint to answer a question.This attribute must have the value interactionText and must provide a comment on your interaction. Note: A minimum of one character is required. The optional attribute, interactionId, can be supplied to use a custom interaction ID. Note: If an ID is not supplied, then the system will automatically create an ID to use. |
amendOrderType: OrderDetails
These attributes are used to request a change to order details/information.
Note: These attributes are not required together and can be used as independent requests.
| Attribute | Description |
|---|---|
| amendOrderType | Mandatory attribute used as part of PATCH /orders/{orderId} endpoint to select an amendment type.This attribute must have the value: OrderDetails. |
| orderDetails.contactDetails | Mandatory attribute used as part of the PATCH /orders/{orderId} endpoint to update contact details on an order.This attribute allows you to add or update the following contactDetails: - contactName - contactType - preferredPhone - alternatePhone Note: If you want to: - add a contact, provide all new and existing contact details in the amend request. - update a contact, provide all updated and existing contact details in the amend request. - remove a contact, send an updated request without the contact details in the amend request. |
| orderDetails.locationDetails | Mandatory attribute used as part of the PATCH /orders/{orderId} endpoint to update location details on an order.This attribute allows you to add or update the following locationDetails: - siteAccessInformation - locationOfEquipment - retainCopper |
| orderDetails.customerDetails | Mandatory attribute used as part of the PATCH /orders/{orderId} endpoint to update order details on an order.This attribute allows you to update the following customerDetails: - endCustomerName - providerReference - notificationPreference. Note: When notificationPreference is set to Notify, you must supply an email address for the notificationEmail attribute. Business Rule: Chorus-ManageOrder-5 |
| orderDetails.billingDetails | Mandatory attribute used as part of the PATCH /orders/{orderId} endpoint to update the billingAccount details on an order. |
Attributes for DELETE /orders/{orderId} endpoint
| Attribute | Description |
|---|---|
| cancelReasonCode | Mandatory attribute used in the DELETE /orders/{orderId} endpoint to confirm the reason for cancellation. Note: An RSP can only use these error codes to cancel but they may see other error codes only available to Chorus in a cancelled order. Cancel reasons The following cancel codes are used to describe the reasons for cancelling an order: - CUSTOMER_CANCEL_13 (Order Acceptance - Primary fibre service already on site (and primary requested)) - CUSTOMER_CANCEL_14 (Order Acceptance - Incorrect pre-qual information) - CUSTOMER_CANCEL_15 (Order Acceptance - Missing order information) - CUSTOMER_CANCEL_16 (Order Acceptance - Duplicate order removed) - CUSTOMER_CANCEL_17 (Order Acceptance - Incorrect Address - No new order submitted) - CUSTOMER_CANCEL_18 (Order Acceptance - Incorrect Address - New order submitted) - CUSTOMER_CANCEL_19 (Customer Cancelled - Excessive delay for RFS) - CUSTOMER_CANCEL_20 (Customer Cancelled - Premise not ready for fibre installation) - CUSTOMER_CANCEL_21 (Customer Cancelled - Fibre not requested) - CUSTOMER_CANCEL_22 (Customer Cancelled - Now moving address) - CUSTOMER_CANCEL_25 (Customer Cancelled - Landlord declined permission) - CUSTOMER_CANCEL_26 (Customer Cancelled - Access Denied) - CUSTOMER_CANCEL_27 (Customer Cancelled - Unhappy with internal scoping options (installation)) - CUSTOMER_CANCEL_28 (Customer Cancelled - Unhappy with external scoping options (installation)) - CUSTOMER_CANCEL_29 (Customer Cancelled - Customer did not accept contribution cost) - CUSTOMER_CANCEL_30 (RSP Cancelled - Incorrect Details) - CUSTOMER_CANCEL_31 (RSP Cancelled - Submitted in Error) - CUSTOMER_CANCEL_32 (RSP Cancelled - Feasibility/Quote rejected by customer) - CUSTOMER_CANCEL_33 (Customer Cancelled - Competitive offer taken up by customer (same RSP)) - CUSTOMER_CANCEL_34 (Customer Cancelled - Health and Safety) Learn more about cancellation reasons |
Attributes for GET /orders/{orderId}/attachments/{attachmentId} endpoint
| Attribute | Description |
|---|---|
| attachmentId | Mandatory attribute used in the GET /orders/{orderId}/attachments/{attachmentId} endpoint to confirm the attachment ID to be retrieved. |
Attributes for GET /orders/{orderId}/notifications endpoint
| Attribute | Description |
|---|---|
| orderId | Mandatory attribute used in the GET /notifications endpoint to retrieve a list of notifications supplied on the given Order ID. |
Attributes for POST /orders/{orderId} endpoint
Order Types: Connect Primary, Modify Attribute, Disconnect Primary for Product Family: PONFAS Distribution
| Attribute | Description |
|---|---|
| productOfferDetails | Mandatory array used as part of the POST /orders/{orderId} endpoint to show the product offer details associated with the request.The array must contain the: 1. Product offer ID (from the product catalogue) 2. Product offer characteristics (name/value pairs) Note: Values for the product offer characteristic attributes are available in the product catalogue. |
| cseProductOfferDetails | Mandatory array for orders with a site visit or a CSE. Used as part of the POST /orders/{orderId} endpoint to show the CSE product offer details associated with the request.The array must contain: 1. CSE product offer ID (from the product catalogue) 2. CSE product offer characteristics (name/value pairs) Note: CSE product offer characteristic attributes are available in the product catalogue. |
| orderDetails | Mandatory attribute used as part of the POST /orders/{orderId} endpoint to add contact details to the order.You can optionally supply additional contact types relevant to the order. If adding one of the following contact types, you must supply a contactName and preferredPhone for that contact: - Order Contact - Site Contact - IT Contact - Additional Contact - Legal Owner - Body Corporate - Property Manager. You can optionally supply the following attributes for any contact you have added to the order: - alternatePhone - email. Business Rule: Chorus-ManageOrder-2 |
| locationDetails | Used as part of the POST /orders/{orderId} endpoint to add location details to the order.For Business and Education market segments, you must supply a value for the locationOfEquipment attribute. You can also supply any site access information relevant to the order. Business Rule: Chorus-ManageOrder-4 |
| customerDetails | Used as part of the POST /orders/{orderId} endpoint to add customer details on the order. You must always supply a value for the attributes: 1. endCustomerName 2. providerReference 3. notificationPreference Notes: - If Project name is used on order submission, it can’t be amended after the order is created. - When notificationPreference is set to Notify, you must supply an email address for the notificationEmail attribute. Business Rule: Chorus-ManageOrder-5 |
| billingDetails | Mandatory attribute used as part of the POST /orders/{orderId} endpoint for billing details on the order. |